Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish docs to GH pages #20

Merged
merged 30 commits into from
Apr 8, 2024
Merged

Publish docs to GH pages #20

merged 30 commits into from
Apr 8, 2024

Conversation

popenta
Copy link
Collaborator

@popenta popenta commented Apr 2, 2024

The published docs can be found here.

@popenta popenta self-assigned this Apr 2, 2024
andreibancioiu
andreibancioiu previously approved these changes Apr 3, 2024
@@ -7,7 +7,7 @@ allow-direct-references = true

[project]
name = "multiversx-sdk"
version = "0.1.0"
version = "0.9.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, since it's latest from here + 1:

https://github.com/multiversx/mx-sdk-py-core/releases

@@ -0,0 +1,35 @@
@ECHO OFF
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:windows: 🙈

But it's OK, we can keep it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well, it's generated :)

@@ -139,3 +139,5 @@ typings/**
!libbls.dll

examples/output

./docs/_build/*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, it's OK to keep the RST files, but exclude the built site 👍

run: |
git config --global user.email "[email protected]"
git config --global user.name "GitHub Actions"
rm -rf ./gh-pages-docs/*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So delete & re-add files. Sounds good.

on:
push:
branches: main
pull_request:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe drop this trigger? Or should we keep it for some time? OK to keep it for a few days / weeks, though.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can remove it in the next PR. I was thinking that maybe we want to check the docs if anyone changes it, but I guess we can do that locally, as well.

andreibancioiu
andreibancioiu previously approved these changes Apr 3, 2024
@popenta popenta merged commit ea1a5e3 into main Apr 8, 2024
4 checks passed
@popenta popenta deleted the add-docs branch April 8, 2024 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants